feat(v2): add remark-admonitions to @docusaurus/preset-classic #2224
Conversation
elviswolcott
requested review from
lex111,
wgao19 and
yangshun
as code owners
|
Hi elviswolcott! Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
elviswolcott
changed the title
remark-admonitions to @docusaurus/preset-classic
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
|
Deploy preview for docusaurus-2 ready! Built with commit bc60549 |
elviswolcott
changed the title
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
|
Where would be the appropriate place to add docs? It seems like https://v2.docusaurus.io/docs/presets/#docusauruspreset-classic would be the right place to mention the config fields (i.e. It seems like the most appropriate place to mention the added syntax would be https://v2.docusaurus.io/docs/markdown-features but I'm not sure if that makes sense given that it's only available if you're using |
On this page we have a corresponding note:
Therefore go ahead this way. |
|
I don't know how I missed that! I'll get the docs added. |
|
If only there was a way to make that more obvious 🤔 |
| This is important | ||
| ::: | ||
|
|
||
| :::caution |
There was a problem hiding this comment.
IMO caution and warning are synonyms. I think it's more conventional for yellow to be caution/warning and red for danger.
See VuePress' version - https://vuepress.vuejs.org/guide/markdown.html#custom-containers
There was a problem hiding this comment.
I already have an alias of danger -> caution. I went with those words so that it is fully backwards compatible with remarkable-admonitions so that anyone upgrading their site will get the expected results.
I based the ordering of caution warning danger on the guidelines provided here favoloso/remarkable-admonitions#4
I can switch around the aliases (i.e. make it warning and danger with caution -> warning) for consistency with Infima over backwards compatibility.
There was a problem hiding this comment.
@yangshun which approach would you prefer?
There was a problem hiding this comment.
This was just a nit comment, it's fine as-is 😄
Motivation
I wrote a remark plugin for admonitions (
remark-admonitions) and mentioned it over in #1238. @yangshun suggested I add it to@docusaurus/preset-classicso I did.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
I tested it in two ways.
@docusaurus/initusing both templates@docusaurus/preset-classicRelated PRs
I haven't added anything to the docs yet as I'm not sure where it would fall under. Right now I'm thinking any docs would go in https://v2.docusaurus.io/docs/markdown-features if admonitions need to be mentioned.